ltecat18.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef LTECAT18_H
#define LTECAT18_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define LTECAT18_CMD_AT                             "AT"
#define LTECAT18_CMD_GET_MODEL_ID                   "AT+CGMM"
#define LTECAT18_CMD_GET_SW_VERSION                 "AT+CGMR"
#define LTECAT18_CMD_GET_SERIAL_NUM                 "AT+CGSN"
#define LTECAT18_CMD_FACTORY_RESET                  "AT&F"
#define LTECAT18_CMD_SET_PHONE_FUNCTIONALITY        "AT+CFUN"
#define LTECAT18_CMD_NETWORK_REGISTRATION           "AT+CREG"
#define LTECAT18_CMD_SIGNAL_QUALITY_REPORT          "AT+CSQ"
#define LTECAT18_CMD_OPERATOR_SELECTION             "AT+COPS"
#define LTECAT18_CMD_SEND_SMS                       "AT+CMGS"
#define LTECAT18_CMD_SELECT_SMS_FORMAT              "AT+CMGF"
#define LTECAT18_CMD_DEFINE_PDP_CONTEXT             "AT+CGDCONT"
#define LTECAT18_CMD_ACTIVATE_PDP_CONTEXT           "AT+CGACT"
#define LTECAT18_CMD_SHOW_PDP_ADDRESS               "AT+CGPADDR"
#define LTECAT18_CMD_START_TCPIP_SERVICE            "AT+NETOPEN"
#define LTECAT18_CMD_OPEN_TCP_UDP_CONNECTION        "AT+CIPOPEN"
#define LTECAT18_CMD_SEND_DATA_VIA_CONNECTION       "AT+CIPSEND"
#define LTECAT18_CMD_RECEIVE_DATA_VIA_CONNECTION    "AT+CIPRXGET"
#define LTECAT18_CMD_CLOSE_TCP_UDP_CONNECTION       "AT+CIPCLOSE"

#define LTECAT18_RSP_OK                             "OK"
#define LTECAT18_RSP_ERROR                          "ERROR"

#define LTECAT18_URC_RECEIVED_DATA                  "+CIPRXGET:"
#define LTECAT18_URC_CONNECTION_OPEN                "+CIPOPEN:"
#define LTECAT18_URC_CONNECTION_CLOSED              "+CIPCLOSE:"

#define LTECAT18_POWER_STATE_OFF                    0
#define LTECAT18_POWER_STATE_ON                     1
#define LTECAT18_POWER_STATE_RESET                  2

#define LTECAT18_TX_DRV_BUFFER_SIZE                 256
#define LTECAT18_RX_DRV_BUFFER_SIZE                 256
 // ltecat18_cmd



#define LTECAT18_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // ltecat18_map // ltecat18

typedef struct
{
    // Output pins
    digital_out_t pwr;              
    digital_out_t rst;              
    digital_out_t rts;              
 
    // Input pins
    digital_in_t ring;              
    digital_in_t cts;               
 
    // Modules
    uart_t uart;                    
 
    // Buffers
    uint8_t uart_rx_buffer[ LTECAT18_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ LTECAT18_TX_DRV_BUFFER_SIZE ];  
    uint8_t cmd_buffer[ LTECAT18_TX_DRV_BUFFER_SIZE ];      
 
} ltecat18_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t pwr;                 
    pin_name_t rst;                 
    pin_name_t rts;                 
    pin_name_t ring;                
    pin_name_t cts;                 
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
} ltecat18_cfg_t;

typedef enum
{
    LTECAT18_OK = 0,
    LTECAT18_ERROR = -1,
    LTECAT18_ERROR_TIMEOUT = -2,
    LTECAT18_ERROR_CMD = -3
 
} ltecat18_return_value_t;


void ltecat18_cfg_setup ( ltecat18_cfg_t *cfg );

err_t ltecat18_init ( ltecat18_t *ctx, ltecat18_cfg_t *cfg );

err_t ltecat18_generic_write ( ltecat18_t *ctx, uint8_t *data_in, uint16_t len );

err_t ltecat18_generic_read ( ltecat18_t *ctx, uint8_t *data_out, uint16_t len );

void ltecat18_set_pwr_pin ( ltecat18_t *ctx, uint8_t state );

void ltecat18_set_rst_pin ( ltecat18_t *ctx, uint8_t state );

void ltecat18_set_rts_pin ( ltecat18_t *ctx, uint8_t state );

uint8_t ltecat18_get_ring_pin ( ltecat18_t *ctx );

uint8_t ltecat18_get_cts_pin ( ltecat18_t *ctx );

void ltecat18_set_power_state ( ltecat18_t *ctx, uint8_t state );

void ltecat18_cmd_run ( ltecat18_t *ctx, uint8_t *cmd );

void ltecat18_cmd_set ( ltecat18_t *ctx, uint8_t *cmd, uint8_t *value );

void ltecat18_cmd_get ( ltecat18_t *ctx, uint8_t *cmd );

void ltecat18_cmd_help ( ltecat18_t *ctx, uint8_t *cmd );

void ltecat18_set_sim_apn ( ltecat18_t *ctx, uint8_t *sim_apn );

void ltecat18_send_sms_text ( ltecat18_t *ctx, uint8_t *phone_number, uint8_t *sms_text );

err_t ltecat18_send_sms_pdu ( ltecat18_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // LTECAT18_H
 // ltecat18
 
// ------------------------------------------------------------------------ END